fix: pin Redoc CDN to @2 instead of @latest#12
Open
dmchaledev wants to merge 1 commit into
Open
Conversation
Using @latest risks silent breakage if Redoc ever ships a v3 with breaking changes, and makes it impossible to add Subresource Integrity (SRI) since the resolved file hash changes on every release. Pinning to @2 keeps the docs on the current stable major series while allowing patch/minor updates, and is a prerequisite for adding an `integrity` attribute in a follow-up.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
docs/index.htmlloads Redoc from jsDelivr using the@latesttag:This creates two risks:
@latestwill resolve to it automatically — silently breaking the public API reference with no code change on our end.@latestresolves to different files over time, making it impossible to add anintegrity="sha384-..."attribute. Without SRI, a compromised CDN could serve malicious JavaScript to anyone visiting the docs.Fix
Pin to
@2— the current stable major series — so we stay on 2.x patch/minor updates while being immune to a future v3 major bump:jsDelivr resolves
@2to the latest2.x.xrelease, so we still get security and bug-fix updates within the major version.Follow-up
Once comfortable pinning to an exact patch version (e.g.
redoc@2.1.3), add acrossorigin="anonymous"attribute and anintegrity="sha384-..."SRI hash to fully protect against CDN-level supply chain attacks.Test plan
Generated by Claude Code